/*
 * 	<pre>
 *	EasyPeas.
 *  Copyright (C) 2007 S Owen
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Jul 24, 2007
 * TemplateFinder.java
 * </pre>
 */
package org.easypeas.templates;

import java.util.Map;

import org.easypeas.annotations.Action;
import org.easypeas.annotations.View;
import org.easypeas.exceptions.UnableToDetermineTemplateException;
import org.easypeas.mappings.Mappings;

/**
 * Determines the path of the template to display according the populated map
 * and mappings defined by {@link View#template()} or {@link Action#forwards()}
 * 
 * @see View
 * @see Action
 * @see Mappings
 * @author S Owen
 * 
 */
public interface TemplateFinder {

	/**
	 * Determines the template to be processed.
	 * 
	 * @param peaMap
	 *            the pea map
	 * @param mappings
	 *            the mappings
	 * 
	 * @return the template name relative to the webapp base directory.
	 * 
	 * @throws UnableToDetermineTemplateException
	 *             the unable to determine template exception
	 */
	String find(Map<String, Object> peaMap, Mappings mappings)
			throws UnableToDetermineTemplateException;
}
